API

Finance APIs

GET finance/general-ledger

List of general ledger postings

HTTP method GET
URI https://api.rambase.net/finance/general-ledger
Supported formats Xml, Html, Json (ex. $format=json)
Maximum page size ($top) 80
Custom fields Custom fields supported
Successful HTTP status code 200
API resource identifier 505, version 13

The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.

Format:
1
1

The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.

$showDomainDescriptions Boolean, optional Set to "true" to include domain descriptions for fields using domain values. See the Domain values page for more information. Default value is false.
$lang String, optional Specifies the language used in the response, following the 3-letter ISO-639-1 [lll]
$access_token String, optional After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time.
$db String, optional Set the database/company for the request
$expand String, optional Use to include output fields that are not returned by default in the response. Accepts a comma-separated list of expandable field names. See the Expand and Select page for more information.
$select String, optional Use to define the fields to return in the response. Accepts a comma-separated list of field names. See the Expand and select page for more information.
$useMinimumVersion Integer, optional Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information.
$format String, optional Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json"
$showCustomFields Boolean, optional Set to "true" to include custom fields. Default value is false.
$top String, optional Specifies number of rows to return in each page. Maximum limit is specific for each API resource. Default value is 10.
$pageKey String, optional Use to navigate to first, previous, next or last page in list. Add $expand=PagingDetails to add the different keys to the response.
$filter String, optional Use to filter the result list, see the Filtering and sorting page for more information.
$orderby String, optional Use to order the result list, see the Filtering and sorting page for more information.
$inlinecount String, optional Set to "allpages" to include total number of rows in the response. Possible values are: "allpages", "none"

Read more about filters and sorting on how to use filter parameters and named filters.

GLPostingWithoutVAT() Named filter Manual general ledger postings without VAT posting
MyGLPostings() Named filter General ledger postings current user is assigned to
PendingCorrection() Named filter General ledger postings which have an error
PendingRegistration() Named filter General ledger postings which are not registered yet
AccountingPeriod Integer Accounting period. Available macros: currentPeriod(), previousPeriod()
Category String Category of general ledger posting.
CountOfJournalEntries Integer Count of journal entries which are linked to general ledger posting.
CreatedByUserId Integer User identifier.
GeneralLedgerPostingId Integer General ledger posting identifier.
LastUpdateDate Date Last update date of general ledger posting. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
Note String Remark of the general ledger posting.
Status String Status of general ledger posting.
TransactionDate Date Transaction date of general ledger posting. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
Type String Type of general ledger posting.
VATPostingId Integer VAT Posting identifier.

Read more about filters and sorting on how to use sortable parameters

AccountingPeriod Integer Accounting period
Category String Category of general ledger posting
CountOfJournalEntries Integer Count of journal entries which are linked to general ledger posting
CreatedByUserId Integer User identifier
GeneralLedgerPostingId Integer General ledger posting identifier
LastUpdateDate Date Last update date of general ledger posting
Note String Remark of the general ledger posting
Status String Status of general ledger posting
TransactionDate Date Transaction date of general ledger posting
Type String Type of general ledger posting
VATPostingId Integer VAT Posting identifier

Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields. Fields colored in grey is expandable fields.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:
1
<GeneralLedgerPostings>
2
     <GeneralLedgerPosting>
3
          <GeneralLedgerPostingId
GeneralLedgerPostingId

General ledger posting identifier

>{Integer}</GeneralLedgerPostingId>
4
          <Status
Status

Status of general ledger posting

Possible domain values can be found here

>{String}</Status>
5
          <CreatedAt
CreatedAt

Date and time of creation

>{Datetime}</CreatedAt>
6
          <Category
Category

Category of general ledger posting

Possible domain values can be found here

>{String}</Category>
7
          <Type
Type

Type of general ledger posting

Possible domain values can be found here

>{String}</Type>
8
          <TransactionDate
TransactionDate

Transaction date of general ledger posting

>{Date}</TransactionDate>
9
          <LastUpdateDate
LastUpdateDate

Last update date of general ledger posting

>{Date}</LastUpdateDate>
10
          <Note
Note

Remark of the general ledger posting

>{String}</Note>
11
          <CountOfJournalEntries
CountOfJournalEntries

Count of journal entries which are linked to general ledger posting

>{Integer}</CountOfJournalEntries>
12
          <VATPosting>
13
               <VATPostingId
VATPostingId

VAT Posting identifier

>{Integer}</VATPostingId>
14
               <VATPostingLink
VATPostingLink

VAT Posting reference

>{String}</VATPostingLink>
15
          </VATPosting>
16
          <CreatedBy>
17
               <UserId
UserId

User identifier

>{Integer}</UserId>
18
               <Name
Name

Name of the user

>{String}</Name>
19
               <FirstName
FirstName

First name of the user

>{String}</FirstName>
20
               <UserLink
UserLink

User reference

>{String}</UserLink>
21
          </CreatedBy>
22
          <AccountingPeriod>
23
               <AccountingPeriodId
AccountingPeriodId

Accounting period identifier

>{Integer}</AccountingPeriodId>
24
               <Period
Period

Accounting period

>{Integer}</Period>
25
               <AccountingPeriodLink
AccountingPeriodLink

Accounting period reference

>{String}</AccountingPeriodLink>
26
          </AccountingPeriod>
27
          <Error
Error

Error message of the general ledger posting

>
28
               <Message
Message

Full error message/description. The message is generated from the specified ErrorMessage object, expanded with the given parameter(s).

>{String}</Message>
29
               <TranslatedMessage
TranslatedMessage

Full translated error description. The language used is specified either in $lang or by user settings. If error message don't exist in desired language, english will be used.

>{String}</TranslatedMessage>
30
               <ErrorMessage>
31
                    <ErrorMessageId
ErrorMessageId

Error message identifier

>{Integer}</ErrorMessageId>
32
                    <ErrorMessageLink
ErrorMessageLink

Error message reference

>{String}</ErrorMessageLink>
33
               </ErrorMessage>
34
               <Parameters>
35
                    <Parameter>
36
                         <Index
Index

Error Key

>{Integer}</Index>
37
                         <Value
Value

Value of the error parameter

>{String}</Value>
38
                    </Parameter>
39
               </Parameters>
40
          </Error>
41
          <GeneralLedgerPostingLink
GeneralLedgerPostingLink

General ledger posting reference

>{String}</GeneralLedgerPostingLink>
42
     </GeneralLedgerPosting>
43
     <Paging
Paging

Detailed paging information for this list.

>
44
          <PageSize
PageSize

Number of elements in the list, as defined in $top. Default is 10.

>{Integer}</PageSize>
45
          <Position
Position

Position of the first element in the list

>{Integer}</Position>
46
          <Page
Page

Page index

>{Integer}</Page>
47
          <FirstPageKey
FirstPageKey

Page key to use for navigating to the first page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</FirstPageKey>
48
          <FirstPage
FirstPage

Link to the first page in the list. $pageKey is set to FirstPageKey.

>{String}</FirstPage>
49
          <PreviousPageKey
PreviousPageKey

Page key to use for navigating to previous page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</PreviousPageKey>
50
          <PreviousPage
PreviousPage

Link to the previous page in the list. $pageKey is set to PreviousPageKey.

>{String}</PreviousPage>
51
          <NextPageKey
NextPageKey

Page key to use for navigating to next page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</NextPageKey>
52
          <NextPage
NextPage

Link to the next page in the list. $pageKey is set to NextPageKey.

>{String}</NextPage>
53
          <LastPageKey
LastPageKey

Page key to use for navigating to last page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</LastPageKey>
54
          <LastPage
LastPage

Link to the last page in the list. $pageKey is set to LastPageKey.

>{String}</LastPage>
55
          <Size
Size

Total number of records in the list. Use $inlinecount=allpages in the request uri to include this

>{Integer}</Size>
56
     </Paging>
57
</GeneralLedgerPostings>
1
{
2
     "generalLedgerPostings": [
3
          {
4
               "generalLedgerPostingId
GeneralLedgerPostingId

General ledger posting identifier

": "{Integer}",
5
               "status
Status

Status of general ledger posting

Possible domain values can be found here

": "{String}",
6
               "createdAt
CreatedAt

Date and time of creation

": "{Datetime}",
7
               "category
Category

Category of general ledger posting

Possible domain values can be found here

": "{String}",
8
               "type
Type

Type of general ledger posting

Possible domain values can be found here

": "{String}",
9
               "transactionDate
TransactionDate

Transaction date of general ledger posting

": "{Date}",
10
               "lastUpdateDate
LastUpdateDate

Last update date of general ledger posting

": "{Date}",
11
               "note
Note

Remark of the general ledger posting

": "{String}",
12
               "countOfJournalEntries
CountOfJournalEntries

Count of journal entries which are linked to general ledger posting

": "{Integer}",
13
               "vATPosting": {
14
                    "vATPostingId
VATPostingId

VAT Posting identifier

": "{Integer}",
15
                    "vATPostingLink
VATPostingLink

VAT Posting reference

": "{String}"
16
               },
17
               "createdBy": {
18
                    "userId
UserId

User identifier

": "{Integer}",
19
                    "name
Name

Name of the user

": "{String}",
20
                    "firstName
FirstName

First name of the user

": "{String}",
21
                    "userLink
UserLink

User reference

": "{String}"
22
               },
23
               "accountingPeriod": {
24
                    "accountingPeriodId
AccountingPeriodId

Accounting period identifier

": "{Integer}",
25
                    "period
Period

Accounting period

": "{Integer}",
26
                    "accountingPeriodLink
AccountingPeriodLink

Accounting period reference

": "{String}"
27
               },
28
               "error
Error

Error message of the general ledger posting

": {
29
                    "message
Message

Full error message/description. The message is generated from the specified ErrorMessage object, expanded with the given parameter(s).

": "{String}",
30
                    "translatedMessage
TranslatedMessage

Full translated error description. The language used is specified either in $lang or by user settings. If error message don't exist in desired language, english will be used.

": "{String}",
31
                    "errorMessage": {
32
                         "errorMessageId
ErrorMessageId

Error message identifier

": "{Integer}",
33
                         "errorMessageLink
ErrorMessageLink

Error message reference

": "{String}"
34
                    },
35
                    "parameters": {
36
                         "parameter": {
37
                              "index
Index

Error Key

": "{Integer}",
38
                              "value
Value

Value of the error parameter

": "{String}"
39
                         }
40
                    }
41
               },
42
               "generalLedgerPostingLink
GeneralLedgerPostingLink

General ledger posting reference

": "{String}"
43
          }
44
     ],
45
     "paging
Paging

Detailed paging information for this list.

": {
46
          "pageSize
PageSize

Number of elements in the list, as defined in $top. Default is 10.

": "{Integer}",
47
          "position
Position

Position of the first element in the list

": "{Integer}",
48
          "page
Page

Page index

": "{Integer}",
49
          "firstPageKey
FirstPageKey

Page key to use for navigating to the first page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",
50
          "firstPage
FirstPage

Link to the first page in the list. $pageKey is set to FirstPageKey.

": "{String}",
51
          "previousPageKey
PreviousPageKey

Page key to use for navigating to previous page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",
52
          "previousPage
PreviousPage

Link to the previous page in the list. $pageKey is set to PreviousPageKey.

": "{String}",
53
          "nextPageKey
NextPageKey

Page key to use for navigating to next page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",
54
          "nextPage
NextPage

Link to the next page in the list. $pageKey is set to NextPageKey.

": "{String}",
55
          "lastPageKey
LastPageKey

Page key to use for navigating to last page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",
56
          "lastPage
LastPage

Link to the last page in the list. $pageKey is set to LastPageKey.

": "{String}",
57
          "size
Size

Total number of records in the list. Use $inlinecount=allpages in the request uri to include this

": "{Integer}"
58
     }
59
}

Possible error codes the response might return:

Error 100619 HTTP 404 Error message not found